DOC: Improved doc for Index.equals
#33289
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mroeschke
reviewed
Apr 4, 2020
pandas/core/indexes/base.py
Outdated
| >>> idx1.equals(pd.Index([1, 2, 3])) | ||
| True | ||
| The dtype is been compared as well |
mroeschke
reviewed
Apr 4, 2020
pandas/core/indexes/base.py
Outdated
| >>> idx1.equals(idx2) | ||
| False | ||
| The oreder is also been compared |
There was a problem hiding this comment.
oreder is also been compared -> order is also compared
pandas/core/indexes/base.py
Outdated
| def equals(self, other: Any) -> bool: | ||
| """ | ||
| Determine if two Index objects contain the same elements. | ||
| Determine if two Index objects contain the same elements with the same order. |
There was a problem hiding this comment.
Or we could also simplify "... contain the same elements with the same order" to "... are equal" ?
We can in a second paragraph detail on what is considered as equal
pandas/core/indexes/base.py
Outdated
| >>> idx1.equals(pd.Index([1, 2, 3])) | ||
| True | ||
| The dtype is been compared as well |
There was a problem hiding this comment.
The dtype is actually not compared:
In [9]: pd.Int64Index([1, 2, 3]).equals(pd.UInt64Index([1, 2, 3]))
Out[9]: True
(in your example here, the values are not equal as a string is not equal to an integer)
added 4 commits
April 5, 2020 16:55
mroeschke
approved these changes
Apr 5, 2020
Co-Authored-By: Joris Van den Bossche <jorisvandenbossche@gmail.com>
jorisvandenbossche
approved these changes
Apr 6, 2020
|
Thanks! |
jbrockmendel
pushed a commit
to jbrockmendel/pandas
that referenced
this pull request
Apr 6, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diff